mp-ma

私有库

一开发环境部署教程一版本升级说明一生产环境部署（centos7）推荐一生产环境部署（windows）一 Z推荐视频教程 A Spring Cloud Gateway网关和动态路由的实现 A 代码生成器使用说明、菜单权限配置 A 使用Maven打包生成jar包到指定目录 A 前端报文加密 A 前端框架文档 A 各终端auth2登录 A 后台用户权限控制 A 图形验证码机制 A 多租户功能 A 如何新建微服务，并用postman接口调试 A 接口直接对外暴露 A 数据库说明 A 数据权限 A 文件上传和存储功能 A 文本编辑器 A 短信发送功能 A 系统功能操作手册 A 逻辑删除 A 阿里巴巴图标库使用 A 项目架构图 A 项目结构说明 A Docker容器部署 A Email邮件发送功能 A Feign服务间相互调用 A Sentinel使用 A Swagger文档配置 A XXL_JOB定时任务使用 A druid数据监控 A seata分布式事务 B 公众号接入教程 B 公众号素材图片防盗链处理 B 微信第三方平台接入 B 微信SDK文档 C 小程序使用自定义导航栏 C 小程序分享海报生成 C 小程序商城客服 C 小程序广告 C 小程序接口访问原理、postman调试【新】 C 小程序接口访问原理、postman调试 C 小程序本地测试和手机预览 C 小程序用户隐私保护指引设置 C 小程序直播功能 C 小程序订阅消息的使用 C 小程序CSS样式组件 D 商城中【乐观锁】的使用 D 商城订单流程说明 D 快递100配置 D redis的key值过期提醒功能使用 Home

Table of Contents

此文件含有可能会与其他字符混淆的 Unicode 字符。如果您是想特意这样的，可以安全地忽略该警告。使用 Escape 按钮显示他们。

快速使用

在pom.xml中引入

    <dependency>
        <groupId>com.joolun</groupId>
        <artifactId>base-common-swagger</artifactId>
    </dependency>

启动类中增加@BaseEnableSwagger注解

@BaseEnableSwagger
@SpringCloudApplication
@EnableBaseFeignClients
@EnableBaseResourceServer
public class BaseWeiXinApplication {

	public static void main(String[] args) {
		SpringApplication.run(BaseWeiXinApplication.class, args);
	}
}

个性化的配置（application-dev.yml）

# Swagger相关的配置
swagger:
  # 标题,默认空
  title: 'JooLun Swagger API'
  # 描述,默认空
  description: 'JooLun微信快速开发框架'
  # 版本,默认空
  version: '2.1.6'
  # 许可证,默认空
  license: 'Powered By JooLun'
  # 许可证URL,默认空
  licenseUrl: 'http://www.joolun.com'
  # 服务条款URL,默认空
  terms-of-service-url: 'http://www.joolun.com'
  # 文档的host信息，默认：空
  host: 'http://www.joolun.com'
  # swagger会解析的包路径,默认为空，扫描所有包
  base-package: '' 
  # swagger会解析的url规则
  base-path: /**
  # 在basePath基础上需要排除的url规则
  exclude-path: 
    - /actuator/**
    - /error  
  # 联系人相关配置
  contact:
    # 联系人姓名，默认空
    name: 'JL'
    # 联系人Email，默认空
    email: 'joolun@gmail.com'
    # 联系人URL，默认空
    url: 'http://www.joolun.com'
  # 统一鉴权相关配置
  authorization:
    # 鉴权策略名称，默认空
    name: 'JooLun OAuth'
    # 需要开启鉴权URL的正则，默认匹配所有
    auth-regex: '^.*$'
    # 鉴权作用域列表配置,默认空
    authorization-scope-list:
        # 鉴权作用域名称,默认空
      - scope: 'server'
        # 鉴权作用域描述,默认空
        description: 'server all'
    # 校验token的地址列表,默认空  
    token-url-list:
      - 'http://localhost:9999/auth/oauth/token'

文档地址： http://base-gateway:9999/doc.html http://base-gateway:9999/swagger-ui.html 参考：https://doc.xiaominfo.com/guide/

文档查看及调试

后台查看接口文档

接口调试，由于前后端都有验权校验，需使用postman工具